Clock (Date and Time) Synchronization Parameters

The device's clock synchronization parameters are described in the table below.

Device Clock Synchronization Parameters

Parameter

Description

NTP

Note: For more information on Network Time Protocol (NTP), see Simple Network Time Protocol Support.

'Enable NTP'

configure system > ntp > enable

[NTPEnable]

Enables the device (as an NTP client) to synchronize its local clock (date and time) with an NTP server.

[0] Disable
[1] Enable (default)

'NTP Interface'

configure system > ntp > ntp-network-interface

[NTPInterface]

Assigns an IP Interface from the IP Interfaces table (see Configuring IP Network Interfaces) for NTP communication.

By default, the IPv4 OAMP interface is assigned.

Note: The IP address version (IPv4 or IPv6) of the assigned IP Interface and the NTP server's address (see 'Primary NTP Server Address' and 'Secondary NTP Server Address' parameters) must be the same.

'Primary NTP Server Address'

configure system > ntp > primary-server

[NTPServerIP]

Defines the address (IPv4 or IPv6, or FQDN) of the primary (main) NTP server. The benefit of using an FQDN is that multiple IP addresses can be resolved from the DNS server, providing NTP server redundancy.

The default IP address is 0.0.0.0.

Note: The IP address version (IPv4 or IPv6) of the NTP server's address and the assigned IP Interface (see 'NTP Interface' parameter) must be the same.

'Secondary NTP Server Address'

configure system > ntp > secondary-server

[NTPSecondaryServerIP]

Defines the address (IPv4 or IPv6, or FQDN) of the secondary NTP server. This NTP is used for redundancy; if the primary NTP server fails, then this NTP server is used.

The default IP address is 0.0.0.0.

Note: The IP address version (IPv4 or IPv6) of the NTP server's address and the assigned IP Interface (see 'NTP Interface' parameter) must be the same.

'NTP Update Interval'

configure system > ntp > update-interval

[NTPUpdateInterval]

Defines the time interval (in seconds) that the NTP client requests for a time update.

The default interval is 86400 (i.e., 24 hours). The range is 0 to 214783647.

Note: It is not recommend to set the parameter to beyond one month (i.e., 2592000 seconds).

'NTP Authentication Key Identifier'

auth-key-id

[NtpAuthKeyId]

Defines the NTP authentication key identifier for authenticating NTP messages. The identifier must match the value configured on the NTP server. The NTP server may have several keys configured for different clients; this number identifies which key is used.

The valid value is 1 to 65535. The default is 0 (i.e., no authentication is done).

'NTP Authentication Secret Key'

configure system > ntp > auth-key-md5

[ntpAuthMd5KeyPassword]

Defines the secret authentication key shared between the device (client) and the NTP server for authenticating NTP messages.

The valid value is a string of up to 32 characters. By default, no key is defined.

Note: The parameter cannot be configured with wide characters.

Regional Clock and Daylight Saving Time

'UTC Offset'

configure system > clock > utc-offset

[NTPServerUTCOffset]

Defines the Universal Time Coordinate (UTC) offset (in seconds) from the local time.

The valid range is -86400 seconds (i.e., -24 hours) to +86400 seconds (i.e., +24 hours). The default is 0.

Note: The offset setting is applied only on the hour. For example, if you configure the parameter at 15:42, the device applies the setting only at 16:00.

'Daylight Saving Time'

configure system > clock > summer-time > summer-time

[DayLightSavingTimeEnable]

Enables daylight saving time (DST).

[0] Disable (default)
[1] Enable

'Start Time / Day of Month Start'

configure system > clock > summer-time > start

[DayLightSavingTimeStart]

Defines the date and time when DST begins. This value can be configured using any of the following formats:

Day of year - mm:dd:hh:mm, where:
mm denotes month
dd denotes date of the month
hh denotes hour
mm denotes minutes

For example, "05:01:08:00" denotes daylight saving starting from May 1 at 8 A.M.

Day of month - mm:day/wk:hh:mm, where:
mm denotes month (e.g., 04)
day denotes day of week (e.g., FRI)
wk denotes week of the month (e.g., 03)
hh denotes hour (e.g., 23)
mm denotes minutes (e.g., 10)

For example, "04:FRI/03:23:00" denotes Friday, the third week of April, at 11 P.M. The week field can be 1-5, where 5 denotes the last occurrence of the specified day in the specified month. For example, "04:FRI/05:23:00" denotes the last Friday of April, at 11 P.M.

'End Time / Day of Month End'

configure system > clock > summer-time > end

[DayLightSavingTimeEnd]

Defines the date and time when DST ends. For a description of the format of this value, see the DayLightSavingTimeStart parameter.

'Offset'

configure system > clock > summer-time > offset

[DayLightSavingTimeOffset]

Defines the DST offset (in minutes).

The valid range is 0 to 120. The default is 60.

Note: The offset setting is applied only on the hour. For example, if you configure the parameter at 15:42, the device applies the setting only at 16:00.

Date Header Date and Time Synchronization

'Synchronize Time from SIP Date Header'

configure system > clock > date-header-time-sync

[DateHeaderTimeSync]

Enables the device to obtain its date and time for its internal clock from the SIP Date header in 200 OK messages received in response to sent REGISTER messages.

[0] Disable (default)
[1] Enable

For more information, see Synchronizing Date and Time through SIP.

'Time Synchronization Interval'

configure system > clock > date-header-time-sync-interval

[DateHeaderTimeSyncInterval]

Defines the minimum time (in seconds) between synchronization updates using the SIP Date header method for clock synchronization.

The valid value range is 60 to 86,400. The default is 900.

For more information, see Synchronizing Date and Time through SIP.

PTP Date and Time Synchronization

'PTP Time Sync'

configure system > clock > ptp-time-sync

[EnablePTP]

Enables the device (virtual machine) to obtain its date and time from the host's virtual PTP (Precision Time Protocol) device.

[0] Disable (default)
[1] Enable

For more information, see Synchronizing Date and Time through PTP.

Note: The parameter is applicable only to Mediant CE/VE deployed on Azure or Hyper-V.